Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated developer documenation #2951

Merged
merged 7 commits into from Mar 20, 2019
Merged

Updated developer documenation #2951

merged 7 commits into from Mar 20, 2019

Conversation

nabobalis
Copy link
Contributor

@nabobalis nabobalis commented Mar 3, 2019

Description

This is part 1 of the epic journey that is, "Nabil goes over all the files in SunPy".

Merged in #2934
Fixes #2931
Fixes #2925
Fixes #1858
Fixes #856
Fixes #1618
Fixes #212

CONTRIBUTING.rst is the one to check the most

The other changes are mainly within the dev_guide section that hopefully explain more about our test suite and how to write/run aspects of SunPy

Built docs.

@nabobalis nabobalis added Documentation Affects the documentation Needs Review Needs reviews before merge labels Mar 3, 2019
@nabobalis nabobalis added this to the 1.0 milestone Mar 3, 2019
@pep8speaks
Copy link

pep8speaks commented Mar 3, 2019

Hello @nabobalis! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2019-03-20 21:03:11 UTC

@ghost
Copy link

ghost commented Mar 3, 2019

Thanks for the pull request @nabobalis! Everything looks great!

@sunpy sunpy deleted a comment Mar 3, 2019
@sunpy sunpy deleted a comment Mar 3, 2019
@sunpy sunpy deleted a comment Mar 3, 2019
tox.ini Outdated Show resolved Hide resolved
@nabobalis

This comment has been minimized.

@nabobalis

This comment has been minimized.

docs/code_ref/io.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Show resolved Hide resolved
CONTRIBUTING.rst Show resolved Hide resolved
docs/dev_guide/code_standards.rst Show resolved Hide resolved
Copy link
Member

@Cadair Cadair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wont pretend to have gone through all this line-by-line but I think it's easy to see it's an improvement on what we have at the moment. I think the contributing.rst is very good (that I did read all of).

@nabobalis
Copy link
Contributor Author

I'm gonna merge this in now and if any problems arise, we can fix them after.

@nabobalis nabobalis merged commit 9fcadf7 into sunpy:master Mar 20, 2019
@nabobalis nabobalis deleted the dev_docs branch March 20, 2019 23:02
@dstansby dstansby removed the Needs Review Needs reviews before merge label Jan 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Affects the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants